Коммит-мессаджи [2/2]

Коммит-мессаджи [2/2]

Идеальная подпись коммита выглядит так: JIRA-1234 Добавил валидацию номера карты в форму оплаты

Или так: JIRA-1234 Перенес компонент Х в дизайн систему, потому что он теперь используется и в профиле пользователя и разделе обратной связи.

Что мы здесь видим: Первым делом идентификатор задачи из трекера задач. Особенно удобно, если у системы контроля версий и трекера задач есть интеграция, тогда этот идентификатор будет кликабельным и приведет прямиком к описанию задачи.

Кстати, если у вас в проекте есть несколько сущностей: эпик, задача, подзадача, то удобнее всего ставить идентификатор той сущности, в которой есть полное описание того, чего вы делаете. Мы, например, в подзадачах описание не пишем, поэтому идентификаторы ставим задач или эпиков в зависимости от ситуации.

Дальше идет глагол. Думаю тут понятно, мы или что-то удалили, либо добавили, либо изменили. Возможно отрефакторили или переместили. Это ключевое слово, которое описывает происходящее. Не забывайте глагол. Без него не понятно как изменился код. Плохо: «JIRA-1234 Карточка товара»

Дальше пишем фактуру как можно подробнее. Что, как и зачем. Это не важно сейчас, но пригодится как на дейлике, так и через год, когда будете разбираться чего этот код делает. На этом этапе высок соблазн написать абстрактные вещи: «Сделал рефакторинг карточки». Но через полгода этот коммит не принесет никакой пользы. Поэтому важнее написать подробности: «Исправил адаптивность карточки, чтобы на планшетах были корректные отступы». И тогда, через полгода, любому будет понятно, что если трогаешь этот код, то на отступы и на планшетное отображение нужно обратить особое внимание.

Выдал базу. Отправляй тиммейтам и внедряй!

Подпишись: Евгений Черкасов IT Блог